home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 2 / LSD and 17bit Compendium Deluxe - Volume II.iso / a / prog / misc / gfront11.lha / GUIFront / ReadMe < prev    next >
Text File  |  1994-10-29  |  6KB  |  202 lines
  1.  
  2.               **********************************************
  3.  
  4.                              guifront.library
  5.  
  6.                      GadTools based GUI layout engine
  7.  
  8.                                 Release 1.1
  9.                            Library version 37.3
  10.  
  11.                     Copyright (C) 1994 by Michael Berg
  12.                             All rights Reserved
  13.  
  14.               **********************************************
  15.  
  16. Contents
  17. --------
  18.  
  19. 1. Introduction
  20.  
  21. 2. Installation
  22.  
  23. 3. Requirements
  24.  
  25. 4. Usage
  26.  
  27. 5. Author information
  28.  
  29. 6. Credits
  30.  
  31. 7. History
  32.  
  33.  
  34. 1. Introduction
  35. ---------------
  36.  
  37. This library provides a means of creating fully font sensitive graphic user
  38. interfaces (GUIs) with a minimum of programming efford.  It also provides a
  39. couple of visual enhancements over GadTools, and a more convenient method
  40. of handling gadget hotkey shortcuts.
  41.  
  42. The most important features of GUIFront is:
  43.  
  44. * GadTools foundation, very easy to come to grips with
  45. * Generates fully font sensitive interfaces
  46. * Automatic hotkey handling, including shift-cancellable buttons
  47. * Easy backfilling of windows
  48. * Automatic group framing
  49. * Frame headlines
  50. * New GETALT_KIND with images for file, dir, font, screenmode and "other"
  51. * Automatic ASL requesters
  52. * Hotkey aliasing - use F10 or ENTER as gadget hotkeys
  53. * Offers attractive new XEN look
  54. * Easy to program, tags with suitable default values used most everywhere
  55. * Executables are generally small, most code embedded in the library itself
  56. * Fully supports localizing, including gadget labels and menus
  57. * Preferences editor (localized) allowing customization of applications
  58. * Simple installation (only one library and the preferences editor)
  59.  
  60. The preferences editor allows you to customize...
  61.  
  62. * Gadget fonts
  63. * Frame headline fonts
  64. * Frame headline style (text style, color, left/center/right leading etc)
  65. * Gadget rendering style for each gadget kind (XEN or normal)
  66. * Refreshing (simple or smart)
  67. * Backfill patterns
  68.  
  69. Every setting is controllable on a per-application basis, allowing the user
  70. full control over visual appearance for each application.
  71.  
  72. 2. Installation
  73. ---------------
  74.  
  75. To install GUIFront, copy the library to your LIBS: directory and the
  76. preferences editor to your SYS:Prefs directory. If you want the preferences
  77. editor localized you must also copy the appropriate .catalog files to your
  78. LOCALE: directory.
  79.  
  80. To simplify installation even further, I have provided a number of
  81. installation scripts for use with both IconX and Commodore's Installer
  82. utility. Simply double click the one which is appropriate for your machine
  83. and watch the fireworks.
  84.  
  85. 3. Requirements
  86. ---------------
  87.  
  88. The GUIFront library and its editor both require at least AmigaDOS 2.04.
  89. Any attempted use under kickstart 1.2 or 1.3 will fail.
  90.  
  91. The developer includefiles were written speciffically for the SAS/C
  92. compiler.  They probably work under most other compilers as well, but may
  93. need some tweaking.
  94.  
  95. 4. Usage
  96. --------
  97.  
  98. To maximise code reusability, GUIFront has been implemented as a shared
  99. library.  To use any of the library functions, you must first successfully
  100. open the library, as illustrated below:
  101.  
  102.     #include <proto/guifront.h>
  103.     #include <libraries/guifront.h>
  104.  
  105.     struct Library *GUIFrontBase;
  106.  
  107.     main()
  108.     {
  109.         if (GUIFrontBase = OpenLibrary(GUIFRONTNAME, GUIFRONTVERSION))
  110.         {
  111.             /* GUIFront functions may now be called */
  112.             ...;
  113.             CloseLibrary(GUIFrontBase);
  114.         }
  115.     }
  116.  
  117. For examples on how to use GUIFront, please refer to the included example
  118. programs. You will find a more detailed description of the individual
  119. GUIFront library functions in the developer directory (doc/guifront.doc).
  120.  
  121.  
  122. 5. Author
  123. ---------
  124.  
  125. If you have any comments or suggestions regarding GUIFront, I will gladly
  126. listen. You can reach me on any of the following adresses:
  127.  
  128.           E-mail: mberg@scala.ping.dk  (preferred)
  129.  
  130.             Fido:  2:238/ 24.28
  131.         AmigaNet: 39:140/101.28
  132.  
  133.           S-mail: Michael Berg
  134.                   Sjællandsgade 56, 4
  135.                   8900 Randers
  136.                   Denmark
  137.  
  138.  
  139. 6. Credits
  140. ----------
  141.  
  142. GUIFront could not have become a reality without the helpful assistance of
  143. the following persons:
  144.  
  145. - Nico François for suggestions and invaluable programming assistance.
  146.   Thanks pal! :-)
  147.  
  148. - SAS Institute for supplying the necessary compiler magic
  149.  
  150. - George Beasley for supplying the E developer files
  151.  
  152. - Doug Dyer for his helpful comments
  153.  
  154. - Roger Nordin and the rest of the SPOT.BETA gang for betatesting and
  155.   suggestions
  156.  
  157. - Magnus Holmgren for the swedish translation
  158.  
  159. - Michele Giorato for the italian translation
  160.  
  161. - Stefan Stuntz for MUI. Truly a remarkable piece of work.
  162.  
  163. - The Amiga hard- and software engineering crews for creating the Amiga
  164.  
  165. - Stig Poulsen, Jørn-Bang Andersen and Kenneth Perto for Fido- and Internet
  166.   support
  167.  
  168.  
  169. 7. Library History
  170. ------------------
  171.  
  172. The  following  denotes  the most signifficant changes made to the library.
  173. The most recent version is listed first.
  174.  
  175. For  a history of the preferences editor, please refer to GUIFront.guide in
  176. the Prefs directory.
  177.  
  178. 8.10.94 - Release 1.1, library version 37.3 (Public release)
  179.     - Automatic ASL requesters did not work if there wasn't a BUTTON_KIND
  180.       somewhere in the GUI.
  181.     - Arrow images were rendered incorrectly in some situations.
  182.     - Added GUI_ScreenTitle tag
  183.     - Added GUI_ActualFont tag
  184.     - Smart refreshing did not work properly. A zip-window operation would
  185.       cause gadget labels to disappear (i.e. not get refreshed). Fixed.
  186.     - GUIFront quietly gobbeled up all IDCMP_REFRESHWINDOW events, making
  187.       it impossible (or at least unfeasible) to render custom graphics in
  188.       a GUIFront GUI.
  189.     - Added GFA_VisualUpdateSigBit and GFA_VisualUpdateSigTask to enable
  190.       applications to update their GUIs when their preferences have been
  191.       edited.
  192.     - Using a keyboard shortcut for a button kind sometimes locked up
  193.       the application. Fixed (hopefully).
  194.     - Implemented ALTI_GetScreenMode (gadget image + automatic requester)
  195.     - Added a distinct image for ALTI_GetScreenMode and ALTI_GetFont
  196.     - Fixed various minor and a couple of major bugs
  197.     - Distribution now includes E developer files (courtesy of George Beasley)
  198.     - GTLV_MakeVisible now supported under V37 (goodbye GTLV_Top! :-)
  199.     - Fixed the most obvious integer math roundoff errors.
  200.  
  201. 18.6.94 - Release 1.0, library version 37.2 (Public release)
  202.